DOC-13093-Write-a-tutorial-for-SQL-migration (Couchbase Server) #328
Conversation
RayOffiah
added
documentation
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
2 times, most recently
from
f3d87fe to
e94fc10
Compare
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
from
e94fc10 to
ae12c0a
Compare
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
from
1670e82 to
6d09e1a
Compare
RayOffiah
changed the title
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
2 times, most recently
from
616109e to
b949ede
Compare
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
4 times, most recently
from
c91fc20 to
920b856
Compare
Introduce a detailed migration guide for converting MySQL data to Couchbase Capella, including examples on transforming relational data into document models. Updates also include navigation links and reorganization of shared content for reuse between tutorials. Add SQL to Capella migration tutorial This commit introduces a new guide on migrating data from MySQL to Couchbase Capella, providing step-by-step instructions for users. Additionally, the navigation file has been updated to include a link to the new tutorial. Rename SQL migration tutorial to specify Couchbase Server. Update tutorial to specify MySQL and minimum version requirement Clarify that the tutorial focuses on migrating data specifically from MySQL. Add a note requiring MySQL version 5.7.22 or later due to JSON function usage. Minor grammar and style adjustments. Add reference to MySQL JSON functions in the SQL migration guide Provide a link to the MySQL JSON function reference for additional context and detailed information. Changes for preview Revised headers for consistency in cbimport guide and updated example JSON data in the SQL migration tutorial to better align with a new data model. Added detailed instructions and images for setting up buckets, scopes, collections, and importing data. Update SQL migration tutorial with the document model and examples Add detailed steps, diagrams, and JSON examples for migrating SQL data to a document model, including student and course data. Update the enrollment schema with a 'score' field and clarify how to structure JSON for Couchbase imports. New tutorial page and addition to the navigation menu.
RayOffiah
force-pushed
the
DOC-13093-Write-a-tutorial-for-SQL-migration
branch
from
f1f3ab0 to
581a45a
Compare
Adding preview
| @@ -0,0 +1,236 @@ | |||
| = Migrating your Data from MySQL to Capella | |||
There was a problem hiding this comment.
I'm a bit confused about having the Capella tutorial here, in the release/7.6 branch.
Shouldn't just the Server version be here,
with the Capella one in the capella branch of docs-devex,
and them having equivalent places in the nav for their respective branches?
There was a problem hiding this comment.
Yes, that does make a lot more sense. 🤔
I'll leave the other page where it is, move the Capella page to the Capella branch, and create a new PR.
| If you're running through the examples, | ||
| then you will also need an existing MySQL installation with the preexisting table structure | ||
| defined in xref:student-record-sql-database-section[the following section]. | ||
|
|
There was a problem hiding this comment.
Is it worth mentioning that the examples assume a Unix-type OS, and if you're unfortunate enough to be running Windows you should adjust the file paths accordingly?
I don't have a strong opinion either way, but we've definitely had people ask for this in other docs - however, given WSL, and some ppl running Powershell and not WSL, actually providing an alternative is a bit of a non-starter. 😅
| = Migrating your Data from MySQL to Capella | ||
| :description: Using MySQL as a starting point, this guide demonstrates \ | ||
| how to migrate your existing data from SQL tables to a Couchbase Capella instance. | ||
| :page-topic-type: guide |
There was a problem hiding this comment.
Should this be type tutorial ?
|
|
||
| Before you make a start, you will need a Capella instance to run the tutorial. | ||
| If you do not currently have an instance, | ||
| then you can create a Capella trial here =>{nbsp}https://www.couchbase.com/downloads/?family=capella[Capella Trial] |
There was a problem hiding this comment.
You used : in the Server version of the doc,
but => here.
Perhaps best to stick to just one?
| include::partial$diagrams/student-record-erd.puml[] | ||
| .... | ||
|
|
||
| which we will convert to a document model suitable for storage in our Couchbase bucket: |
There was a problem hiding this comment.
Could we change this so that this isolated line starts with a capital letter:
We will convert this table structure to a document model suitable for storage in our Couchbase bucket:
|
|
||
|
|
||
| We can handle this JSON structure by using a more involved SELECT: | ||
| as well as extracting the student records, we can simultaneously pull in the enrollments for each student: |
There was a problem hiding this comment.
We can handle this JSON structure by using a more involved SELECT.
As well as extracting the student records, we can simultaneously pull in the enrollments for each student:
| read the sections on xref:manage:manage-buckets/bucket-management-overview.adoc[Managing Buckets] | ||
| and xref:manage:manage-scopes-and-collections/manage-scopes-and-collections.adoc[Managing Scopes and Collections] | ||
|
|
||
| ''' |
There was a problem hiding this comment.
I didn't know we used this <hr /> type thing.
Interesting to see.
There was a problem hiding this comment.
I think I've seen Sarah use it in a few places.
There was a problem hiding this comment.
Thanks @RayOffiah
I think this mostly works well, and all but one of my comments is fairly trivial. 👍
However, I don't think we can merge until we look at why the Capella tutorial is alongside the self-managed one in the release/7.6 branch, instead of in the Capella docs, via devex's capella branch.
Description
This pull request updates the SQL migration tutorial with comprehensive instructions, examples, and enhancements. Key changes include:
Checklist
Preview
https://preview.docs-test.couchbase.com/docs-devex-DOC-13093-Write-a-tutorial-for-SQL-migration/server/current/tutorials/migration-tutorial/sql-migration-tutorial.html